Skip to content

OSDOCS-16941: DITA abstracts — OLM catalog/config topics#115366

Open
stevsmit wants to merge 1 commit into
openshift:mainfrom
stevsmit:osdocs-16941-dita-abstracts-1
Open

OSDOCS-16941: DITA abstracts — OLM catalog/config topics#115366
stevsmit wants to merge 1 commit into
openshift:mainfrom
stevsmit:osdocs-16941-dita-abstracts-1

Conversation

@stevsmit

@stevsmit stevsmit commented Jul 14, 2026

Copy link
Copy Markdown
Member

Summary

Rewrites DITA short descriptions ([role="_abstract"]) for 28 OLM catalog, config, and software-catalog topics from OSDOCS-16941 attachments. Removes duplicative intro paragraphs where the new abstract covers the same intent.

Jira

https://redhat.atlassian.net/browse/OSDOCS-16941

Versions

4.20+

Merge order

Independent branch from main (abstracts only). Preferred merge order: first in series (abstracts → callouts #115365 → other-vale). Rebase later PRs if same-file conflicts.

Files changed

  • 28 files across operators/admin/, operators/understanding/, and modules/ (see PR Files changed)

Vale rules addressed

  • AsciiDocDITA.ShortDescription

Notes

  • CQA 2.0 DITA pre-migration (AsciiDocDITA scope only)
  • Does not include RedHat style-guide fixes unless noted

Made with Cursor

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 14, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 14, 2026

Copy link
Copy Markdown

@stevsmit: This pull request references OSDOCS-16941 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set.

Details

In response to this:

Summary

Rewrites DITA short descriptions ([role="_abstract"]) for 28 OLM catalog, config, and software-catalog topics from OSDOCS-16941 attachments. Removes duplicative intro paragraphs where the new abstract covers the same intent.

Jira

https://redhat.atlassian.net/browse/OSDOCS-16941

Versions

4.20+

Merge order

Independent branch from main (abstracts only). Preferred merge order: first in series (abstracts → callouts #115365 → other-vale). Rebase later PRs if same-file conflicts.

Files changed

  • 28 files across operators/admin/, operators/understanding/, and modules/ (see PR Files changed)

Vale rules addressed

  • AsciiDocDITA.ShortDescription

Notes

  • CQA 2.0 DITA pre-migration (AsciiDocDITA scope only)
  • Does not include RedHat style-guide fixes unless noted

Made with Cursor

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 14, 2026
@stevsmit stevsmit force-pushed the osdocs-16941-dita-abstracts-1 branch from 141f953 to 45e2659 Compare July 14, 2026 15:26
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 14, 2026

Copy link
Copy Markdown

🤖 Tue Jul 14 18:13:35 - Prow CI generated the docs preview:
https://115366--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

@stevsmit stevsmit force-pushed the osdocs-16941-dita-abstracts-1 branch 2 times, most recently from ab8843c to 1f65004 Compare July 14, 2026 17:59
@openshift-ci openshift-ci Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 14, 2026
Co-authored-by: Cursor <cursoragent@cursor.com>
@stevsmit stevsmit force-pushed the osdocs-16941-dita-abstracts-1 branch from 1f65004 to e3fac1b Compare July 14, 2026 18:01
@openshift-ci

openshift-ci Bot commented Jul 14, 2026

Copy link
Copy Markdown

@stevsmit: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants